Wallet Contract placeholder #10269

staffik · 2023-11-29T19:45:36Z

Context

NEP: near/NEPs#518
Tracking issue: #10018.

Goal

We want the NEAR Protocol's ecosystem to be closer with Ethereum by integrating Web3 wallet support.
To accomplish that, some changes on the protocol level are needed with an emphasis on user experience continuity.
Following the design, the main change on the protocol level would be to have ETH-style addresses managed by a new Wallet Contract integrated into the protocol. For seamless onboarding of EVM users, the contract will be free of charge.

Previous work

This PR is built on top of two PRs:

Setup for ETH-implicit accounts #10020: no-op PR, laying groundwork for further changes.
ETH-implicit account support #10224: empty contract as a placeholder, literally deployed to new ETH accounts.

Summary

This PR adds near-wallet-contract crate (based on runtime/near-test-contracts) that exposes Wallet Contract WASM code to the runtime.
It stops deploying a copy of the Wallet Contract to each newly created ETH-implicit account.
Instead, it uses an in-memory cached contract code on execute_function_call action from such account.

Changes

Add wallet-contract crate (separated from the workspace) with placeholder Wallet Contract implementation.
Add near-wallet-contract crate (part of the workspace) that generates (through build.rs) and exposes the Wallet Contract WASM code.
Do not literally deploy Wallet Contract when creating ETH-implicit account. Just store reference to the Wallet Contract.
Treat ETH-implicit accounts specially when retrieving contract code from an account (in such case returns in-memory cached Wallet Contract code).
Add tests calling Wallet Contract where a transfer from an ETH-implicit account is possible depending on the public key passed with rlp_transaction argument.

codecov · 2023-11-30T18:07:26Z

Codecov Report

Attention: 16 lines in your changes are missing coverage. Please review.

Comparison is base (abf6e99) 71.81% compared to head (f4a097c) 71.90%.
Report is 25 commits behind head on master.

Files	Patch %	Lines
runtime/near-wallet-contract/src/lib.rs	58.97%	16 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #10269      +/-   ##
==========================================
+ Coverage   71.81%   71.90%   +0.08%     
==========================================
  Files         712      715       +3     
  Lines      143098   143755     +657     
  Branches   143098   143755     +657     
==========================================
+ Hits       102763   103361     +598     
- Misses      35625    35651      +26     
- Partials     4710     4743      +33

Flag	Coverage Δ
backward-compatibility	`0.08% <0.00%> (-0.01%)`	⬇️
db-migration	`0.08% <0.00%> (-0.01%)`	⬇️
genesis-check	`1.26% <0.00%> (-0.01%)`	⬇️
integration-tests	`36.35% <76.11%> (+0.17%)`	⬆️
linux	`71.49% <23.52%> (-0.22%)`	⬇️
linux-nightly	`71.47% <76.11%> (+0.08%)`	⬆️
macos	`55.24% <0.00%> (+0.23%)`	⬆️
pytests	`1.48% <0.00%> (-0.01%)`	⬇️
sanity-checks	`1.28% <0.00%> (-0.01%)`	⬇️
unittests	`68.17% <19.40%> (+<0.01%)`	⬆️
upgradability	`0.13% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

staffik · 2023-12-07T22:10:06Z

I am not sure how Wallet Contract upgrade should be supported.
E.g. do we want to be able to dynamically switch the WASM file used?

birchmd

Nice job! I have a few comments/questions but overall looks good.

runtime/near-wallet-contract/res/nightly_wallet_contract.wasm

runtime/near-wallet-contract/src/lib.rs

runtime/runtime/src/actions.rs

integration-tests/src/tests/client/features/delegate_action.rs

birchmd · 2023-12-08T15:30:11Z

I am not sure how Wallet Contract upgrade should be supported. E.g. do we want to be able to dynamically switch the WASM file used?

I do not think we want to support dynamic upgrades. It would be a complex feature to get right because you still need to have all the nodes agree on what the right Wallet Contract binary to use is, so you would need its hash to be a property of the epoch or something like that.

Upgrades will always have to be protocol upgrades. Both the old and new binaries will need to be kept and the node would need to switch which one is used depending on the protocol version.

wacban · 2023-12-08T16:11:07Z

Sorry for the delay, I was busy with investigations, I'll have a look on Monday.

wacban

Great stuff!

Please also have it reviewed by someone from the runtime team as there are a lot of pieces that I have absolutely no context on.

runtime/near-wallet-contract/README.md

runtime/near-wallet-contract/build.rs

runtime/near-wallet-contract/wallet-contract/src/lib.rs

runtime/runtime/src/actions.rs

staffik · 2023-12-14T17:56:36Z

Here are the all review changes, mainly:

Addressed @Ekleog-NEAR comments.
Moved Wallet Contract tests to a separate file and added some tests.
near[wallet contract hash] is deployed as a contract code to new ETH-implicit accounts.
Wallet Contract is checked into the repository and it is included into the binary at compile time. By default it is not recompiled, one can recompile it with cargo build --features build_wallet_contract.

The solution of pulling the crate out of the workspace works fine for near-test-contracts, which we do not really care about. However, for wallet-contract, we definitely do care a lot about it being correct. Have you tried having it within the workspace, which would allow all our CI tooling to also apply to it, and thus all the related linters?

@Ekleog-NEAR I've built this PR with the wallet-contract crate being part of the workspace, and I liked the linter.
But after the PR was ready I removed the crate with this commit because introducing near-sdk dependency caused crazy changes to the workspace Cargo.lock and introduced vulnerable dependency.

I spent some time trying to fix that but without success. The crate was only used during the build and I thought I will separate it from the workspace. Now it is not even used during build by default.

Ekleog-NEAR

For the vulnerable dependencies, that’s something we definitely need to fix on the near-sdk side, because right now we’re pushing everyone to use these vulnerable dependencies.

For wee-alloc, the change recommended by the rustsec advisory is to just use Rust’s default allocator. For ed25519, bumping near-crypto & co to 0.18 (as soon as I can get it released, currently we’re facing a few issues with the release) should deal with the issue. I’d suggest fixing the wee-alloc issue, and ignoring the red cargo-audit checkmark for ed25519 for now, considering it’s dependencies that only get used for non-wasm32 targets.

Anyway, I think we can merge this as is for now, and merge the wallet contract into the workspace as a follow-up PR :)

I think the only comment here that really needs action before landing is, removing the prebuilt .wasm file, because it’s currently impossible to reproduce. It’ll make operational deployment harder, but if we check in a binary file, we definitely need it to be reproducible.

In order to keep operational deployment easy for now, I’d suggest compiling the include_bytes! conditionally on the nightly feature flag only (and eg. having a hardcoded empty slice on stable), this way we can gain some time to decide what the proper process should be there :)

runtime/near-wallet-contract/wallet-contract/Cargo.toml

runtime/near-wallet-contract/README.md

runtime/near-wallet-contract/build.rs

runtime/runtime/src/actions.rs

birchmd

Looks good to me! We only need to address the issue of reproducible build for the contract, and I think that can be done as a follow-up PR.

runtime/near-wallet-contract/build.rs

runtime/near-wallet-contract/src/lib.rs

In some circumstances, `runtime/near-wallet-contract/build.rs` is triggered and it regenerates the Wallet Contract WASM file for unrelated PRs: #10422 (comment). The `Wallet Contract` will be generated differently (#10269 (comment)), but for now I would like to include this tiny PR to stops auto-generating the WASM file by default. To test that the WASM file is not auto-regenerated, add a space to `runtime/near-wallet-contract/wallet-contract/src/lib.rs` and run `cargo build --features nightly`.

staffik mentioned this pull request Nov 29, 2023

[ProjectTracking]: Ethereum address implicit accounts #10018

Closed

8 tasks

staffik force-pushed the wallet-contract-placeholder branch 5 times, most recently from 89a9aab to dccf038 Compare November 30, 2023 17:54

wallet-contract package

0bf0e9d

staffik force-pushed the wallet-contract-placeholder branch 2 times, most recently from 6a77447 to 3051ba2 Compare December 7, 2023 15:24

Test Wallet Contract

7b0a69c

staffik force-pushed the wallet-contract-placeholder branch from 3051ba2 to 7b0a69c Compare December 7, 2023 15:40

staffik added 2 commits December 7, 2023 18:39

Virtually deployed Wallet Contract

fb53898

Zero-balance ETH-implicit accounts. Add comments.

17a7072

staffik force-pushed the wallet-contract-placeholder branch from ca2211f to 3abf599 Compare December 7, 2023 21:25

Isolate wallet-contract from workspace

1614346

staffik force-pushed the wallet-contract-placeholder branch from 3abf599 to 1614346 Compare December 7, 2023 21:48

staffik marked this pull request as ready for review December 7, 2023 21:58

staffik requested a review from a team as a code owner December 7, 2023 21:58

staffik requested review from nikurt, birchmd and wacban December 7, 2023 21:58

birchmd reviewed Dec 8, 2023

View reviewed changes

Do not commit auto-generated wasm files

b138347

staffik force-pushed the wallet-contract-placeholder branch from d3b62bc to b138347 Compare December 8, 2023 17:11

wacban approved these changes Dec 11, 2023

View reviewed changes

staffik requested a review from Ekleog-NEAR December 11, 2023 14:25

staffik added 8 commits December 13, 2023 17:10

Remove nightly_wallet_contract. Precompile Wallet Contract.

8d26665

Use Arc<ContractCode> for WalletContract

9996fe6

Include WASM file content directly in the binary at compile time.

41b889e

Move Wallet Contract tests to a separate file

be2500c

Include Wallet Contract WASM file into repository

f6cf30c

Deploy Wallet Contract as near[wallet contract hash].

daececf

Revert zeroize version to 1.6.0

fb82386

Add comments

07a9069

staffik requested review from Ekleog-NEAR and birchmd December 14, 2023 17:28

Ekleog-NEAR approved these changes Dec 15, 2023

View reviewed changes

Do not check-in wallet_contract.wasm

efdfa9b

staffik force-pushed the wallet-contract-placeholder branch from 37d8a88 to f0163ad Compare December 15, 2023 18:02

staffik removed the request for review from birchmd December 15, 2023 18:13

staffik force-pushed the wallet-contract-placeholder branch 2 times, most recently from abbd100 to 53f7a8a Compare December 15, 2023 18:36

Add empty wasm file.

a1c8633

staffik force-pushed the wallet-contract-placeholder branch from 53f7a8a to a1c8633 Compare December 15, 2023 18:59

staffik requested a review from birchmd December 15, 2023 19:05

birchmd approved these changes Dec 18, 2023

View reviewed changes

runtime/near-wallet-contract/build.rs Show resolved Hide resolved

runtime/near-wallet-contract/src/lib.rs Show resolved Hide resolved

Ignore wallet contract hash checking tests. Add TODO comments

f4a097c

staffik added this pull request to the merge queue Dec 18, 2023

Merged via the queue into master with commit 68c190d Dec 18, 2023
19 checks passed

staffik deleted the wallet-contract-placeholder branch December 18, 2023 15:14

This was referenced Jan 15, 2024

feat: add a metric which counts how many chunks couldn't fit all transactions from the pool #10422

Merged

Disable auto-generation of wallet contract by default #10436

Merged

staffik mentioned this pull request Apr 12, 2024

Feat(eth-wallet-contract): reproducible build #11011

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wallet Contract placeholder #10269

Wallet Contract placeholder #10269

staffik commented Nov 29, 2023 •

edited

Loading

codecov bot commented Nov 30, 2023 •

edited

Loading

staffik commented Dec 7, 2023 •

edited

Loading

birchmd left a comment

birchmd commented Dec 8, 2023

wacban commented Dec 8, 2023

wacban left a comment

staffik commented Dec 14, 2023 •

edited

Loading

Ekleog-NEAR left a comment

birchmd left a comment

Wallet Contract placeholder #10269

Wallet Contract placeholder #10269

Conversation

staffik commented Nov 29, 2023 • edited Loading

Context

Goal

Previous work

Summary

Changes

codecov bot commented Nov 30, 2023 • edited Loading

Codecov Report

staffik commented Dec 7, 2023 • edited Loading

birchmd left a comment

Choose a reason for hiding this comment

birchmd commented Dec 8, 2023

wacban commented Dec 8, 2023

wacban left a comment

Choose a reason for hiding this comment

staffik commented Dec 14, 2023 • edited Loading

Ekleog-NEAR left a comment

Choose a reason for hiding this comment

birchmd left a comment

Choose a reason for hiding this comment

staffik commented Nov 29, 2023 •

edited

Loading

codecov bot commented Nov 30, 2023 •

edited

Loading

staffik commented Dec 7, 2023 •

edited

Loading

staffik commented Dec 14, 2023 •

edited

Loading